Client asking for MP information
Client asking for MP information
- application/json
Request Body required
Optional description in Markdown
request object
Data model for a request
offset object required
Send/start time of the first message/notification
- "0" ==> immediate response
timeUnit string requiredPossible values: Value must match regular expression
[a-zA-Z]*:[a-zA-Z]+
, [unit:secondUnitOfTime
,unit:minuteUnitOfTime
,unit:hour
,unit:day
,unit:week
,unit:month
,unit:year
]Specifies the unit in which the time is represented
value number requiredThe amount of timeUnits considered
customerId string requiredInternal customerId
precisionOfForecast object
Accuracy of the time specification of the completion date.
- default: implicitly defined by production
- only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy.
timeUnit string requiredPossible values: Value must match regular expression
[a-zA-Z]*:[a-zA-Z]+
, [unit:secondUnitOfTime
,unit:minuteUnitOfTime
,unit:hour
,unit:day
,unit:week
,unit:month
,unit:year
]Specifies the unit in which the time is represented
value number requiredThe amount of timeUnits considered
productionForecastForAll boolean requiredBoolean variable that detemines whether the customer request information about each position of an order, or information about the complete order
orderId string requiredThe Id identifying subject of the request
deviationOfSchedule object
Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber
mandatory for CommunicationMode = "notification"
timeUnit string requiredPossible values: Value must match regular expression
[a-zA-Z]*:[a-zA-Z]+
, [unit:secondUnitOfTime
,unit:minuteUnitOfTime
,unit:hour
,unit:day
,unit:week
,unit:month
,unit:year
]Specifies the unit in which the time is represented
value number requiredThe amount of timeUnits considered
notificationInterval object
Interval time that either specifies the cyclic send time or limits the notification time mandatory for CommunicationMode = "cyclic"
timeUnit string requiredPossible values: Value must match regular expression
[a-zA-Z]*:[a-zA-Z]+
, [unit:secondUnitOfTime
,unit:minuteUnitOfTime
,unit:hour
,unit:day
,unit:week
,unit:month
,unit:year
]Specifies the unit in which the time is represented
value number requiredThe amount of timeUnits considered
communicationMode string requiredPossible values: [
synchronous
,cyclic
,notification
]Specification of the communication mode
versionDataModel string requiredSpecifies the used version of the data model
header object required
Contains information common to all messages
messageId string requiredUnique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.
context string requiredInformation about the context the message should be considered in. Default: For Use Cases which need to validate against the Semantic Hub automatically. Fallback: For Use Cases which do not use automatic validation. In both cases: Versioning only refers to major versions. String pattern of the value follows:
- - sentDateTime string requiredPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Time zone aware timestamp holding the date and the time the message was sent by the sending party. The value MUST be formatted according to the ISO 8601 standard
senderBpn string requiredThe Business Partner Number of the sending party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard
receiverBpn string requiredThe Business Partner Number of the receiving party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard.
expectedResponseBy stringPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Time zone aware timestamp holding the date and time by which the sending party expects a certain type of response from the receiving party. The meaning and interpretation of the fields's value are context-bound and MUST therefore be defined by any business domain or platform capability making use of it. The value MUST be formatted according to the ISO 8601 standard
relatedMessageId stringUnique ID identifying a message somehow related to the current one
version string requiredThe version of the standard defining the semantics and the structure of the message's header. The version number should follow the Semantic Versioning 2.0.0 specification.
- 200
- 201
- 400
- 401
- 403
- 420
- 421
- 422
- 423
- 424
- 425
- 426
OK. The request has succeeded
OK, Precision not possible. The request has succeeded. Precision is not possible, the default precision will be used
Bad request. The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
Unauthorized. Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
Forbidden. The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource.
Unknown BPNS. The BPNS which is given as parameter is not registered in the data provider database as a direct partner.
Invalid CustomerId. The customerID unknown or invalid
Invalid OrderId. The orderID not found or invalid
Invalid Notification Interval. The data field Notification interval is not set with a proper value or missing
Invalid Deviation. The data field Deviation is not set with a proper value or missing
Forbidden. The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource.
incomplete Request